@cspell/dict-aws

What is @cspell/dict-aws?

@cspell/dict-aws is a dictionary extension for the CSpell spell checker that includes AWS-specific terms. This package helps developers ensure that AWS-related terminology is correctly spelled in their documentation, code comments, and other text files.

What are @cspell/dict-aws's main functionalities?

AWS-specific dictionary

This feature allows you to add AWS-specific terms to the CSpell spell checker, ensuring that AWS-related terminology is recognized and correctly spelled.

const cspell = require('cspell');
cspell.addDictionary('aws');

Integration with CSpell

This feature demonstrates how to integrate the AWS dictionary with CSpell to check a text for spelling errors, including AWS-specific terms.

const cspell = require('cspell');
cspell.addDictionary('aws');
const text = 'Deploying to AWS using CloudFormation.';
const spellingErrors = cspell.checkText(text);
console.log(spellingErrors);

Other packages similar to @cspell/dict-aws

@cspell/dict-python

This package provides a dictionary of Python-specific terms for the CSpell spell checker. It is similar to @cspell/dict-aws but focuses on Python terminology instead of AWS.

@cspell/dict-java

This package offers a dictionary of Java-specific terms for the CSpell spell checker. Like @cspell/dict-aws, it helps ensure that language-specific terminology is correctly spelled, but it is tailored for Java.

@cspell/dict-html

This package includes a dictionary of HTML-specific terms for the CSpell spell checker. It is similar to @cspell/dict-aws but focuses on HTML terminology.

README

CSpell AWS Terms Dictionary

AWS terms dictionary for cspell.

This is a pre-built dictionary for use with cspell.

Requirements

Tool	Version
cspell	>= 6
Code Spell Checker - Visual Studio Code	>= 2

Installation

Global Install and add to cspell global settings.

npm install -g @cspell/dict-aws
cspell link add @cspell/dict-aws

Uninstall from cspell

cspell link remove @cspell/dict-aws

Manual Installation

The cspell-ext.json file in this package should be added to the import section in your cspell.json file.

{
    // …
    "import": ["@cspell/dict-aws/cspell-ext.json"],
    // …
}

Building

Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.

npm run build

License

MIT

Some packages may have other licenses included.